Reseller Identification And Validation API
Response Attributes
/searchReseller
Method: POST
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | total | Number | "total": 5 | Number of records matched based on the input | |
| 2 | page | Number | "page": 1 | Results fetched based on the input page size | |
| 3 | limit | Number | "limit": 3 | Index of the starting record in the response based on the value in request payload | |
| 4 | next | String | "next": "https://apx-test.cisco.com/dfm/services/reseller/v1/searchReseller?page=2&limit=3" | Flag indicating if the total no of records have been returned. If the value is false, call the service by changing the start index for incremental data. If the value is true, no need to call the service for incremental data. | |
| 5 | prev | Number | "prev": null | Identifies the unique record in response | |
| 6 | distiName | String | "distiName": "TD Disit Name" | Distributor Xml Reference ID provided in the input | |
| 7 | distiValResellerAcNo | String | "distiValResellerAcNo": "0001012511" | Unique distributor source profile id in the input | |
| 8 | distiValSoldToName | String | "distiValSoldToName": "INTERNATIONAL TURNKEY SYSTEMS" | Distributor Sales Order Number | |
| 9 | partnerName | String | "partnerName": "INTERNATIONAL TURNKEY SYSTEMS" | Distributor Sales Order Line Number | |
| 10 | partnerSiteName | String | "partnerSiteName": "INTERNATIONAL TURNKEY SYSTEMS" | Reflects the status of the booking transaction | |
| 11 | address1 | String | "address1": "NATIONAL BANK OF UMM AL-QAIWAIN BLDGBUR DUBAI" | Reflects whether the booking is New or Change | |
| 12 | address2 | String | "address2": "" | Reflects the net unit price on the deal | |
| 13 | city | String | "city": "DUBAI" | Deal Id associated with the booking | |
| 14 | state | String | "state": "" | Magic Key associated with the Deal on the booking | |
| 15 | postalCode | String | "postalCode": "" | Reflects the Promotion Number | |
| 16 | country | String | "country": "UNITED ARAB EMIRATES" | Booking Expiration Date. Timezone is in PST | |
| 17 | partnerSiteID | String | "partnerSiteID": "2698570" | Booking Extended Expiration Date. Timezone is in PST | |
| 18 | pdbBeGeoID | String | "pdbBeGeoID": "5410" | Reflects the Service Quote Number | |
| 19 | partnerType | String | "partnerType": "VAR" | Reflects the Mfg Part Number / SKU | |
| 20 | certification | String | "certification": "GOLD" | DSV Booking Quantity associated with the SKU | |
| 21 | certEffectiveStartDate | String | "certEffectiveStartDate": "27-SEP-2022" | Reported Net Unit Price by the distributor on the booking in USD | |
| 22 | certificationExpiryDate | String | "certificationExpiryDate": "27-SEP-2023" | Remaining quantity on the deal for consumption | |
| 23 | specialization | Array | "specialization": [{"specType": "AENAS","validUntil": "05-MAY-24"},{"specType": "ASAS","validUntil": "23-APR-24"}] | Rebate submitted by distributor per unit | |
| 24 | authorization | Array | "authorization": [{"authType": "CPIA","validUntil": "12-NOV-68"},{"authType": "CSPP","validUntil": "11-FEB-24"}] | Whole Sale Price List in local currency | |
| 25 | registrationStatus | String | "registrationStatus": "REGISTERED" | Reseller To Disti PO Number | |
| 26 | regEffectiveStartDate | String | "regEffectiveStartDate": "12-FEB-2023" | Customer Requested Ship Date. Timezone is in PST | |
| 27 | registrationExpiryDate | String | "registrationExpiryDate": "11-FEB-2024" | Buyer/ Reseller Name associated with the booking | |
| 28 | phoneNumber | String | "phoneNumber": "0097143972220" | Buyer / Reseller Partner Identification | |
| 29 | website | String | "website": "WWW.ITS.WS" | EndCustomer Name associated with the booking |
/gdvrResellers
Method: POST
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | total | Number | "total": 5 | Number of records matched based on the input | |
| 2 | page | Number | "page": 1 | Results fetched based on the input page size | |
| 3 | limit | Number | "limit": 3 | Index of the starting record in the response based on the value in request payload | |
| 4 | next | String | "next": "https://apx-test.cisco.com/dfm/services/reseller/v1/gdvrResellers?page=2&limit=3" | Flag indicating if the total no of records have been returned. If the value is false, call the service by changing the start index for incremental data. If the value is true, no need to call the service for incremental data. | |
| 5 | prev | Number | "prev": null | Identifies the unique record in response | |
| 6 | partnerName | String | "partnerName": "PARTNER NAME" | Distributor Sales Order Line Number | |
| 7 | beGeoID | String | "beGeoID": "123456" | Reflects the status of the booking transaction | |
| 8 | partnerSiteId | String | "partnerSiteId": "98749" | Reflects the status of the booking transaction | |
| 9 | address | String | "address": "Street Address 1" | Reflects whether the booking is New or Change | |
| 10 | city | String | "city": "Morrisville" | Deal Id associated with the booking | |
| 11 | state | String | "state": "NC" | Magic Key associated with the Deal on the booking | |
| 12 | country | String | "country": "USA" | Magic Key associated with the Deal on the booking | |
| 13 | postalCode | String | "postalCode": "27703" | Reflects the Promotion Number | |
| 14 | webAddress | String | "webAddress": "WWW.webaddress.com" | Booking Expiration Date. Timezone is in PST | |
| 15 | list | String | "list": "DNR" | Booking Expiration Date. Timezone is in PST |
/addReseller
Method: POST
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | distiName | String | "distiName": "xyz disti name" | Distributor Xml Reference ID provided in the input | |
| 2 | distiValResellerAcNo | String | "distiValResellerAcctNo": "123455" | Unique distributor source profile id in the input | |
| 3 | distiValSoldToName | String | "distiValSoldToName": "INTERNATIONAL TURNKEY SYSTEMS" | Distributor Sales Order Number | |
| 4 | partnerName | String | "partnerName": "INTERNATIONAL TURNKEY SYSTEMS" | Distributor Sales Order Line Number | |
| 5 | partnerSiteName | String | "partnerSiteName": "INTERNATIONAL TURNKEY SYSTEMS" | Reflects the status of the booking transaction | |
| 6 | address1 | String | "address1": "NATIONAL BANK OF UMM AL-QAIWAIN BLDGBUR DUBAI" | Reflects whether the booking is New or Change | |
| 7 | address2 | String | "address2": "" | Reflects the net unit price on the deal | |
| 8 | city | String | "city": "DUBAI" | Deal Id associated with the booking | |
| 9 | state | String | "state": "" | Magic Key associated with the Deal on the booking | |
| 10 | postalCode | String | "postalCode": "" | Reflects the Promotion Number | |
| 11 | requestDescription | String | "requestDescription": "ADD" | Reflects the Promotion Number | |
| 12 | responseStatus | String | "responseStatus": "success" | Reflects the Promotion Number | |
| 13 | responseMessage | String | "responseMessage": "Reseller information added successfully" | Reflects the Promotion Number |
/updateReseller
Method: POST
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | distiName | String | "distiName": "xyz disti name" | Distributor Xml Reference ID provided in the input | |
| 2 | distiValResellerAcNo | String | "distiValResellerAcctNo": "123455" | Unique distributor source profile id in the input | |
| 3 | distiValSoldToName | String | "distiValSoldToName": "INTERNATIONAL TURNKEY SYSTEMS" | Distributor Sales Order Number | |
| 4 | partnerName | String | "partnerName": "INTERNATIONAL TURNKEY SYSTEMS" | Distributor Sales Order Line Number | |
| 5 | partnerSiteName | String | "partnerSiteName": "INTERNATIONAL TURNKEY SYSTEMS" | Reflects the status of the booking transaction | |
| 6 | address1 | String | "address1": "NATIONAL BANK OF UMM AL-QAIWAIN BLDGBUR DUBAI" | Reflects whether the booking is New or Change | |
| 7 | address2 | String | "address2": "" | Reflects the net unit price on the deal | |
| 8 | city | String | "city": "DUBAI" | Deal Id associated with the booking | |
| 9 | state | String | "state": "" | Magic Key associated with the Deal on the booking | |
| 10 | postalCode | String | "postalCode": "" | Reflects the Promotion Number | |
| 11 | requestDescription | String | "requestDescription": "ADD" | Reflects the Promotion Number | |
| 12 | responseStatus | String | "responseStatus": "success" | Reflects the Promotion Number | |
| 13 | responseMessage | String | "responseMessage": "Reseller information added successfully" | Reflects the Promotion Number |
/deleteReseller
Method: POST
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | distiName | String | "distiName": "xyz disti name" | Distributor Xml Reference ID provided in the input | |
| 2 | distiValResellerAcNo | String | "distiValResellerAcctNo": "123455" | Unique distributor source profile id in the input | |
| 3 | distiValSoldToName | String | "distiValSoldToName": "INTERNATIONAL TURNKEY SYSTEMS" | Distributor Sales Order Number | |
| 4 | partnerName | String | "partnerName": "INTERNATIONAL TURNKEY SYSTEMS" | Distributor Sales Order Line Number | |
| 5 | partnerSiteName | String | "partnerSiteName": "INTERNATIONAL TURNKEY SYSTEMS" | Reflects the status of the booking transaction | |
| 6 | address1 | String | "address1": "NATIONAL BANK OF UMM AL-QAIWAIN BLDGBUR DUBAI" | Reflects whether the booking is New or Change | |
| 7 | address2 | String | "address2": "" | Reflects the net unit price on the deal | |
| 8 | city | String | "city": "DUBAI" | Deal Id associated with the booking | |
| 9 | state | String | "state": "" | Magic Key associated with the Deal on the booking | |
| 10 | postalCode | String | "postalCode": "" | Reflects the Promotion Number | |
| 11 | requestDescription | String | "requestDescription": "ADD" | Reflects the Promotion Number | |
| 12 | responseStatus | String | "responseStatus": "success" | Reflects the Promotion Number | |
| 13 | responseMessage | String | "responseMessage": "Reseller information added successfully" | Reflects the Promotion Number |